////////////////////////////////////////////////////////////////////////////////
//
//  The MIT License
//
//  Copyright (c) 2008 - 2009. Dimarik
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
//
////////////////////////////////////////////////////////////////////////////////

package ru.goodcore.logging.formatters {

import ru.goodcore.logging.LogEvent;


/**
 * @author					Dimarik
 * @version					1.0
 * @playerversion			Flash 9
 * @langversion				3.0
 *
 * @keyword					itargetmessageformatter
 */
public interface ITargetMessageFormatter {

	//--------------------------------------------------------------------------
	//
	//  Properties
	//
	//--------------------------------------------------------------------------

	//----------------------------------
	//  fieldSeparator
	//----------------------------------

	/**
	 *  The separator string to use between fields
	 */
	function set fieldSeparator(value:String):void;

	function get fieldSeparator():String;

	//----------------------------------
	//  includeCategory
	//----------------------------------

	/**
	 *  Indicates if the category for this target should added to the trace.
	 */
	function set includeCategory(value:Boolean):void;

	function get includeCategory():Boolean;

	//----------------------------------
	//  includeDate
	//----------------------------------

	/**
	 *  Indicates if the date should be added to the trace.
	 */
	function set includeDate(value:Boolean):void;

	function get includeDate():Boolean;

	//----------------------------------
	//  includeLevel
	//----------------------------------

	/**
	 *  Indicates if the level for the event should added to the trace.
	 */
	function set includeLevel(value:Boolean):void;

	function get includeLevel():Boolean;

	//----------------------------------
	//  includeTime
	//----------------------------------

	/**
	 *  Indicates if the time should be added to the trace.
	 */
	function set includeTime(value:Boolean):void;

	function get includeTime():Boolean;

	//----------------------------------
	//  includeMeasuredTime
	//----------------------------------

	/**
	 *  Indicates if the time should be added to the trace.
	 */
	function set includeMeasuredTime(value:Boolean):void;

	function get includeMeasuredTime():Boolean;

	//--------------------------------------------------------------------------
	//
	//  Methods
	//
	//--------------------------------------------------------------------------

	function formatMessage(event:LogEvent):String;
	

}
}